<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GrPPI: worker_pool.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b519bdaee6a7f8dbbe55c1237cf8f544.html">native</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">worker_pool.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="worker__pool_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright 2018 Universidad Carlos III de Madrid</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef GRPPI_NATIVE_WORKER_POOL_H</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define GRPPI_NATIVE_WORKER_POOL_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;thread&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrppi.html">grppi</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html">   29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrppi_1_1worker__pool.html">worker_pool</a> {</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#ac3ebceb29ce8143d5a8741a029657e72">   36</a></span>&#160;    <a class="code" href="classgrppi_1_1worker__pool.html#ac3ebceb29ce8143d5a8741a029657e72">worker_pool</a>(<span class="keywordtype">int</span> num_threads) noexcept : </div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;        num_threads_{num_threads},</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        workers_{}</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    {}</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#a92f880356d613af8d0270934a4cbaa33">   45</a></span>&#160;    <a class="code" href="classgrppi_1_1worker__pool.html#a92f880356d613af8d0270934a4cbaa33">~worker_pool</a>() noexcept { this-&gt;<a class="code" href="classgrppi_1_1worker__pool.html#afcc57d84e91af6655791c5b013d21d86">wait</a>(); }</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#a4b1e1870589dc3474ccda45e2e9e1760">   47</a></span>&#160;    <a class="code" href="classgrppi_1_1worker__pool.html#a4b1e1870589dc3474ccda45e2e9e1760">worker_pool</a>(<a class="code" href="classgrppi_1_1worker__pool.html">worker_pool</a> &amp;&amp;) noexcept = default;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#afc5a6f1d2762e5889d2abcdcb8aaf271">   48</a></span>&#160;    <a class="code" href="classgrppi_1_1worker__pool.html">worker_pool</a> &amp; operator=(<a class="code" href="classgrppi_1_1worker__pool.html">worker_pool</a> &amp;&amp;) noexcept = default;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    </div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    template &lt;typename E, typename F, typename ... Args&gt;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#a69692568387a5e8070313ac4694542ca">   60</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classgrppi_1_1worker__pool.html#a69692568387a5e8070313ac4694542ca">launch</a>(const E &amp; ex, F f, Args &amp;&amp; ... args) {</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;      workers_.emplace_back([=,&amp;ex]() {</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        <span class="keyword">auto</span> manager = ex.thread_manager();</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        f(args...);</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;      });</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    }</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> E, <span class="keyword">typename</span> F, <span class="keyword">typename</span> ... Args&gt;</div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#a80258ae8f52dbf76ec8e83b61e21e2c9">   68</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classgrppi_1_1worker__pool.html#a80258ae8f52dbf76ec8e83b61e21e2c9">launch_tasks</a>(<span class="keyword">const</span> E &amp; ex, F &amp;&amp; f, Args &amp;&amp; ... args) {</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;      <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i=0; i&lt;num_threads_; ++i) {</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        workers_.emplace_back([=,&amp;ex]() {</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;          <span class="keyword">auto</span> manager = ex.thread_manager();</div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;          f(args...);</div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        });</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;      }</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    }</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160; </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="classgrppi_1_1worker__pool.html#afcc57d84e91af6655791c5b013d21d86">   81</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classgrppi_1_1worker__pool.html#afcc57d84e91af6655791c5b013d21d86">wait</a>() noexcept {</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;      <span class="keywordflow">for</span> (<span class="keyword">auto</span> &amp;&amp; w : workers_) { w.join(); }</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;      workers_.clear();</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    }</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keyword">const</span> <span class="keywordtype">int</span> num_threads_;</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    std::vector&lt;std::thread&gt; workers_;</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;};</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;}</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html"><div class="ttname"><a href="classgrppi_1_1worker__pool.html">grppi::worker_pool</a></div><div class="ttdoc">Pool of worker threads. This class offers a simple pool of worker threads.</div><div class="ttdef"><b>Definition:</b> worker_pool.h:29</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_a4b1e1870589dc3474ccda45e2e9e1760"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#a4b1e1870589dc3474ccda45e2e9e1760">grppi::worker_pool::worker_pool</a></div><div class="ttdeci">worker_pool(worker_pool &amp;&amp;) noexcept=default</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_a69692568387a5e8070313ac4694542ca"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#a69692568387a5e8070313ac4694542ca">grppi::worker_pool::launch</a></div><div class="ttdeci">void launch(const E &amp;ex, F f, Args &amp;&amp;... args)</div><div class="ttdoc">Launch a function in the pool.</div><div class="ttdef"><b>Definition:</b> worker_pool.h:60</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_a80258ae8f52dbf76ec8e83b61e21e2c9"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#a80258ae8f52dbf76ec8e83b61e21e2c9">grppi::worker_pool::launch_tasks</a></div><div class="ttdeci">void launch_tasks(const E &amp;ex, F &amp;&amp;f, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> worker_pool.h:68</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_a92f880356d613af8d0270934a4cbaa33"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#a92f880356d613af8d0270934a4cbaa33">grppi::worker_pool::~worker_pool</a></div><div class="ttdeci">~worker_pool() noexcept</div><div class="ttdoc">Destructs the worker pool after joining with all threads in the pool.</div><div class="ttdef"><b>Definition:</b> worker_pool.h:45</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_ac3ebceb29ce8143d5a8741a029657e72"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#ac3ebceb29ce8143d5a8741a029657e72">grppi::worker_pool::worker_pool</a></div><div class="ttdeci">worker_pool(int num_threads) noexcept</div><div class="ttdoc">Creates a worker pool with a number of threads.</div><div class="ttdef"><b>Definition:</b> worker_pool.h:36</div></div>
<div class="ttc" id="aclassgrppi_1_1worker__pool_html_afcc57d84e91af6655791c5b013d21d86"><div class="ttname"><a href="classgrppi_1_1worker__pool.html#afcc57d84e91af6655791c5b013d21d86">grppi::worker_pool::wait</a></div><div class="ttdeci">void wait() noexcept</div><div class="ttdoc">Wait until all launched tasks have been completed.</div><div class="ttdef"><b>Definition:</b> worker_pool.h:81</div></div>
<div class="ttc" id="anamespacegrppi_html"><div class="ttname"><a href="namespacegrppi.html">grppi</a></div><div class="ttdef"><b>Definition:</b> callable_traits.h:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>
